<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="ColorMunch,beekay.colormunch.ColorMunch,COMMENTS_BY_EMAIL,COMMENTS_BY_THEME_ID,COMMENTS_URL,FILTER_EMAIL,FILTER_HEX,FILTER_NONE,FILTER_TAG,FILTER_THEME_ID,FILTER_TITLE,FILTER_USER_ID,ITEMS_PER_PAGE,KULER_NAMESPACE,LIST_HIGHEST_RATED,LIST_MOST_RECENT,LIST_POPULAR,LIST_RANDOM,LIST_URL,SEARCH_URL,START_INDEX,TIME_SPAN,getAllComments,getAllThemes,getCommentByIndex,getCommentCount,getRandomComment,getRandomTheme,getThemeByIndex,getThemeCount,loadComments,loadThemes,searchThemes" name="keywords">
<title>beekay.colormunch.ColorMunch</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'ColorMunch - API Documentation';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">ColorMunch - an AS3 library for the Adobe Kuler API</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?beekay/colormunch/ColorMunch.html&amp;beekay/colormunch/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;ColorMunch</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class ColorMunch"); titleBar_setSubNav(true,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">beekay.colormunch</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class ColorMunch</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ColorMunch <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
</tr>
</table>
<p></p>
  Manages communication with the Adobe Kuler API
  
  <p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#ColorMunch()">ColorMunch</a>(apiKey:String)</div>
<div class="summaryTableDescription">
   Crate a new ColorMunch instance
   
   </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getAllComments()">getAllComments</a>():Array</div>
<div class="summaryTableDescription">
   Get all comments from the feed result
   
   </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getAllThemes()">getAllThemes</a>():Array</div>
<div class="summaryTableDescription">
   Get all themes from the feed result
   
   </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getCommentByIndex()">getCommentByIndex</a>(index:int):<a href="../colormunch/Comment.html">Comment</a>
</div>
<div class="summaryTableDescription">
   Get a specific Comment from the feed result
   
   </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getCommentCount()">getCommentCount</a>():int</div>
<div class="summaryTableDescription">
   Get the total number of comments in the feed result
   
   </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getRandomComment()">getRandomComment</a>():<a href="../colormunch/Comment.html">Comment</a>
</div>
<div class="summaryTableDescription">
   Get a random comment from the feed result
   
   </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getRandomTheme()">getRandomTheme</a>():<a href="../colormunch/Theme.html">Theme</a>
</div>
<div class="summaryTableDescription">
   Get a random theme from the feed result
   
   </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeByIndex()">getThemeByIndex</a>(index:int):<a href="../colormunch/Theme.html">Theme</a>
</div>
<div class="summaryTableDescription">
   Get a specific Theme from the feed result
   
   </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getThemeCount()">getThemeCount</a>():int</div>
<div class="summaryTableDescription">
   Get the total number of themes in the feed result
   
   </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#loadComments()">loadComments</a>(filter:String, query:String, startIndex:int, itemsPerPage:int):void</div>
<div class="summaryTableDescription">
   Starts the process of loading Kuler theme comments
   <p>The following events may dispatched during the process<ul><li>ColorMunchEvent.ERROR : The list type is invalid.</div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#loadThemes()">loadThemes</a>(listType:String, startIndex:int, timeSpan:int, itemsPerPage:int):void</div>
<div class="summaryTableDescription">
   Starts the process of loading a Kuler themes list
   <p>The following events may dispatched during the process<ul><li>ColorMunchEvent.ERROR : The list type is invalid.</div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#searchThemes()">searchThemes</a>(filter:String, query:String, startIndex:int, itemsPerPage:int):void</div>
<div class="summaryTableDescription">
   Starts the process of searching Kuler themes
   <p>The following events may dispatched during the process<ul><li>ColorMunchEvent.ERROR : The list type is invalid.</div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<table id="summaryTableConstant" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#COMMENTS_BY_EMAIL">COMMENTS_BY_EMAIL</a> : String = "email"<div class="summaryTableDescription">[static]
  search type for retrieving comments by author email
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#COMMENTS_BY_THEME_ID">COMMENTS_BY_THEME_ID</a> : String = "themeID"<div class="summaryTableDescription">[static]
  search type for retrieving comments by themeID
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#COMMENTS_URL">COMMENTS_URL</a> : String = "http://kuler-api.adobe.com/rss/comments.cfm"<div class="summaryTableDescription">[static]
  The API url for retrieving a comments
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FILTER_EMAIL">FILTER_EMAIL</a> : String = "email"<div class="summaryTableDescription">[static]
  email search filter
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FILTER_HEX">FILTER_HEX</a> : String = "hex"<div class="summaryTableDescription">[static]
  hex search filter
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FILTER_NONE">FILTER_NONE</a> : String = ""<div class="summaryTableDescription">[static]
  Clears the search filter
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FILTER_TAG">FILTER_TAG</a> : String = "tag"<div class="summaryTableDescription">[static]
  tag search filter
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FILTER_THEME_ID">FILTER_THEME_ID</a> : String = "themeID"<div class="summaryTableDescription">[static]
  themeID search filter
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FILTER_TITLE">FILTER_TITLE</a> : String = "title"<div class="summaryTableDescription">[static]
  Theme title search filter
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#FILTER_USER_ID">FILTER_USER_ID</a> : String = "userID"<div class="summaryTableDescription">[static]
  userID search filter
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#ITEMS_PER_PAGE">ITEMS_PER_PAGE</a> : int = 20<div class="summaryTableDescription">[static]
  default itemsPerPage value
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#KULER_NAMESPACE">KULER_NAMESPACE</a> : String = "http://kuler.adobe.com/kuler/API/rss/"<div class="summaryTableDescription">[static]
  The namespace value in the result XML
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#LIST_HIGHEST_RATED">LIST_HIGHEST_RATED</a> : String = "rating"<div class="summaryTableDescription">[static]
  List type for retrieving the highest rated themes
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#LIST_MOST_RECENT">LIST_MOST_RECENT</a> : String = "recent"<div class="summaryTableDescription">[static]
  List type for retrieving the mos recent themes
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#LIST_POPULAR">LIST_POPULAR</a> : String = "popular"<div class="summaryTableDescription">[static]
  List type for retrieving the most popular themes
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#LIST_RANDOM">LIST_RANDOM</a> : String = "random"<div class="summaryTableDescription">[static]
  List type for retrieving random themes
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#LIST_URL">LIST_URL</a> : String = "http://kuler-api.adobe.com/feeds/rss/get.cfm"<div class="summaryTableDescription">[static]
  The API url for retrieving a themes list 
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#SEARCH_URL">SEARCH_URL</a> : String = "http://kuler-api.adobe.com/rss/search.cfm"<div class="summaryTableDescription">[static]
  The API url for searching
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#START_INDEX">START_INDEX</a> : int = 0<div class="summaryTableDescription">[static]
  default startIndex value
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#TIME_SPAN">TIME_SPAN</a> : int = 0<div class="summaryTableDescription">[static]
  default timeSpan value
  </div>
</td><td class="summaryTableOwnerCol">ColorMunch</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="ColorMunch()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ColorMunch</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function ColorMunch(apiKey:String)</code><p>
   Crate a new ColorMunch instance
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">apiKey</span>:String</code> &mdash; Your Adobe Kuler developer API key
   
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="getAllComments()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getAllComments</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function getAllComments():Array</code><p>
   Get all comments from the feed result
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Array</code> &mdash; An array of comments. Each array item is of type Comment
   
-   </td>
</tr>
</table>
</div>
<a name="getAllThemes()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getAllThemes</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getAllThemes():Array</code><p>
   Get all themes from the feed result
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Array</code> &mdash; An array of themes. Each array item is of type Theme
   
-   </td>
</tr>
</table>
</div>
<a name="getCommentByIndex()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getCommentByIndex</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getCommentByIndex(index:int):<a href="../colormunch/Comment.html">Comment</a></code><p>
   Get a specific Comment from the feed result
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> &mdash; The array index of the comment
   
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../colormunch/Comment.html">Comment</a></code> &mdash; 
                        The requested comment
   
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getCommentCount()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getCommentCount</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getCommentCount():int</code><p>
   Get the total number of comments in the feed result
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>int</code> &mdash; The total number of comments
   
   </td>
</tr>
</table>
</div>
<a name="getRandomComment()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getRandomComment</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getRandomComment():<a href="../colormunch/Comment.html">Comment</a></code><p>
   Get a random comment from the feed result
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../colormunch/Comment.html">Comment</a></code> &mdash; 
                        A random comment
   
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getRandomTheme()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getRandomTheme</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getRandomTheme():<a href="../colormunch/Theme.html">Theme</a></code><p>
   Get a random theme from the feed result
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../colormunch/Theme.html">Theme</a></code> &mdash; 
                        A random theme
   
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getThemeByIndex()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeByIndex</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeByIndex(index:int):<a href="../colormunch/Theme.html">Theme</a></code><p>
   Get a specific Theme from the feed result
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> &mdash; The array index of the theme
   
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../colormunch/Theme.html">Theme</a></code> &mdash; 
                        The requested theme
   
   
                        
                     </td>
</tr>
</table>
</div>
<a name="getThemeCount()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getThemeCount</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getThemeCount():int</code><p>
   Get the total number of themes in the feed result
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>int</code> &mdash; The total number of themes
   
   </td>
</tr>
</table>
</div>
<a name="loadComments()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">loadComments</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function loadComments(filter:String, query:String, startIndex:int, itemsPerPage:int):void</code><p>
   Starts the process of loading Kuler theme comments
   </p><p>The following events may dispatched during the process<ul><li>ColorMunchEvent.ERROR : The list type is invalid. See event.data in your event handler for detail</li><li>ColorMunchEvent.BUSY : This ColourFeed instance is already processing a request</li><li>ColorMunchEvent.LOAD_ERROR : A problem was encountered loading the feed</li><li>ColorMunchEvent.RESULT_EMPTY : There were zero results returned</li><li>ColorMunchEvent.RESULT_READY : The result has been parsed and the can now to be read (via the explicit getters)</li></ul></p>
   
   <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">filter</span>:String</code> &mdash; The filter to search by. <p>Options are<ul><li>ColorMunch.COMMENTS_BY_EMAIL (comments are retrieved for themes created by this user)</li><li>ColorMunch.COMMENTS_BY_THEME_ID (comments are retrieved for the specified theme)</li></ul></p>
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">query</span>:String</code> &mdash; The value associated with the filter. If the filter is ColorMunch.COMMENTS_BY_EMAIL then query would be a users' email address, else if the filter is ColorMunch.COMMENTS_BY_THEME_ID then the query would be a themeID.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">startIndex</span>:int</code> &mdash; (optional) A 0-based index into the list that specifies the first item to display. Default is 0, which displays the first item in the list.
    </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">itemsPerPage</span>:int</code> &mdash; (optional) The maximum number of items to display, in the range 1..100. Default is 20.
   
   </td>
</tr>
</table>
</div>
<a name="loadThemes()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">loadThemes</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function loadThemes(listType:String, startIndex:int, timeSpan:int, itemsPerPage:int):void</code><p>
   Starts the process of loading a Kuler themes list
   </p><p>The following events may dispatched during the process<ul><li>ColorMunchEvent.ERROR : The list type is invalid. See event.data in your event handler for detail</li><li>ColorMunchEvent.BUSY : This ColourFeed instance is already processing a request</li><li>ColorMunchEvent.LOAD_ERROR : A problem was encountered loading the feed</li><li>ColorMunchEvent.RESULT_EMPTY : There were zero results returned</li><li>ColorMunchEvent.RESULT_READY : The result has been parsed and the can now to be read (via the explicit getters)</li></ul></p>
   
   <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">listType</span>:String</code> &mdash; (optional) The type of list to return. <p>Options are<ul><li>ColorMunch.LIST_MOST_RECENT (default - Get most recent themes)</li><li>ColorMunch.LIST_POPULAR (Get most popular themes)</li><li>ColorMunch.LIST_HIGHEST_RATED (Get highest-rated themes)</li><li>ColorMunch.LIST_RANDOM (Get random themes)</li></ul></p>
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">startIndex</span>:int</code> &mdash; (optional) A 0-based index into the list that specifies the first item to display. Default is 0, which displays the first item in the list.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">timeSpan</span>:int</code> &mdash; (optional) Value in days to limit the set of themes retrieved. Default is 0, which retrieves all themes without time limit.
    </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">itemsPerPage</span>:int</code> &mdash; (optional) The maximum number of items to display, in the range 1..100. Default is 20.
   
   </td>
</tr>
</table>
</div>
<a name="searchThemes()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">searchThemes</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function searchThemes(filter:String, query:String, startIndex:int, itemsPerPage:int):void</code><p>
   Starts the process of searching Kuler themes
   </p><p>The following events may dispatched during the process<ul><li>ColorMunchEvent.ERROR : The list type is invalid. See event.data in your event handler for detail</li><li>ColorMunchEvent.BUSY : This ColourFeed instance is already processing a request</li><li>ColorMunchEvent.LOAD_ERROR : A problem was encountered loading the feed</li><li>ColorMunchEvent.RESULT_EMPTY : There were zero results returned</li><li>ColorMunchEvent.RESULT_READY : The result has been parsed and the can now to be read (via the explicit getters)</li></ul></p>
   
   <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">filter</span>:String</code> &mdash; The filter to narrow your search. <p>Options are<ul><li>ColorMunch.FILTER_NONE (No filter. Will perform search on theme titles, tags, author names, themeIDs, authorIDs, and hexValues)</li><li>ColorMunch.FILTER_THEME_ID (Search on a specific themeID)</li><li>ColorMunch.FILTER_USER_ID (Search on a specific userID)</li><li>ColorMunch.FILTER_EMAIL (Search on a specific email)</li><li>ColorMunch.FILTER_TAG (Search on a tag word)</li><li>ColorMunch.FILTER_HEX (Search on a hex colour value - can be in the format "ABCDEF" or "0xABCDEF")</li><li>ColorMunch.FILTER_TITLE (Search on a theme title)</li></ul></p>
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">query</span>:String</code> &mdash; The search query. Use a simple string term to search on;
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">startIndex</span>:int</code> &mdash; (optional) A 0-based index into the list that specifies the first item to display. Default is 0, which displays the first item in the list.
    </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">itemsPerPage</span>:int</code> &mdash; (optional) The maximum number of items to display, in the range 1..100. Default is 20.
   
   </td>
</tr>
</table>
</div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="COMMENTS_BY_EMAIL"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">COMMENTS_BY_EMAIL</td><td class="detailHeaderType">constant</td>
</tr>
</table>
<div class="detailBody">
<code>public static const COMMENTS_BY_EMAIL:String = "email"</code><p>
  search type for retrieving comments by author email
  </p></div>
<a name="COMMENTS_BY_THEME_ID"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">COMMENTS_BY_THEME_ID</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const COMMENTS_BY_THEME_ID:String = "themeID"</code><p>
  search type for retrieving comments by themeID
  </p></div>
<a name="COMMENTS_URL"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">COMMENTS_URL</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const COMMENTS_URL:String = "http://kuler-api.adobe.com/rss/comments.cfm"</code><p>
  The API url for retrieving a comments
  </p></div>
<a name="FILTER_EMAIL"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FILTER_EMAIL</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const FILTER_EMAIL:String = "email"</code><p>
  email search filter
  </p></div>
<a name="FILTER_HEX"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FILTER_HEX</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const FILTER_HEX:String = "hex"</code><p>
  hex search filter
  </p></div>
<a name="FILTER_NONE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FILTER_NONE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const FILTER_NONE:String = ""</code><p>
  Clears the search filter
  </p></div>
<a name="FILTER_TAG"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FILTER_TAG</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const FILTER_TAG:String = "tag"</code><p>
  tag search filter
  </p></div>
<a name="FILTER_THEME_ID"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FILTER_THEME_ID</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const FILTER_THEME_ID:String = "themeID"</code><p>
  themeID search filter
  </p></div>
<a name="FILTER_TITLE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FILTER_TITLE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const FILTER_TITLE:String = "title"</code><p>
  Theme title search filter
  </p></div>
<a name="FILTER_USER_ID"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">FILTER_USER_ID</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const FILTER_USER_ID:String = "userID"</code><p>
  userID search filter
  </p></div>
<a name="ITEMS_PER_PAGE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ITEMS_PER_PAGE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const ITEMS_PER_PAGE:int = 20</code><p>
  default itemsPerPage value
  </p></div>
<a name="KULER_NAMESPACE"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">KULER_NAMESPACE</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const KULER_NAMESPACE:String = "http://kuler.adobe.com/kuler/API/rss/"</code><p>
  The namespace value in the result XML
  </p></div>
<a name="LIST_HIGHEST_RATED"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">LIST_HIGHEST_RATED</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const LIST_HIGHEST_RATED:String = "rating"</code><p>
  List type for retrieving the highest rated themes
  </p></div>
<a name="LIST_MOST_RECENT"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">LIST_MOST_RECENT</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const LIST_MOST_RECENT:String = "recent"</code><p>
  List type for retrieving the mos recent themes
  </p></div>
<a name="LIST_POPULAR"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">LIST_POPULAR</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const LIST_POPULAR:String = "popular"</code><p>
  List type for retrieving the most popular themes
  </p></div>
<a name="LIST_RANDOM"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">LIST_RANDOM</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const LIST_RANDOM:String = "random"</code><p>
  List type for retrieving random themes
  </p></div>
<a name="LIST_URL"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">LIST_URL</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const LIST_URL:String = "http://kuler-api.adobe.com/feeds/rss/get.cfm"</code><p>
  The API url for retrieving a themes list 
  </p></div>
<a name="SEARCH_URL"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">SEARCH_URL</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const SEARCH_URL:String = "http://kuler-api.adobe.com/rss/search.cfm"</code><p>
  The API url for searching
  </p></div>
<a name="START_INDEX"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">START_INDEX</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const START_INDEX:int = 0</code><p>
  default startIndex value
  </p></div>
<a name="TIME_SPAN"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">TIME_SPAN</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const TIME_SPAN:int = 0</code><p>
  default timeSpan value
  </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
